Operations
The operations controller is responsible for managing long running operations such as scans, deployments and patch downloads. Several POST commands will return a URI reference to the operations controller. You can query the controller to poll for the status of a long running operation. If the operation is complete when the status query is performed, another URI is returned that can be used to ask for the result of the long running operation.
Base URL
https://<consoleFQDN:port>/st/console/api/v1.0/operations
Supported Requests
| Method | URL | Input | Return |
|---|---|---|---|
|
DELETE |
https://<consoleFQDN:port>/st/console/api/v1.0/operations/{id of long running operation} |
|
Success or failure code |
|
https://<consoleFQDN:port>/st/console/api/v1.0/operations/{id of long running operation}/{run as credential id} |
|
Success or failure code |
|
|
GET |
https://<consoleFQDN:port>/st/console/api/v1.0/operations/{id of long running operation} |
|
Operation status |
Input Model
None
Example with Sample Response
Monitor the status of a patch scan.
GET Request
https://<consoleFQDN:port>/st/console/api/v1.0/operations/3608e6f3-3f66-43b0-95db-ae1f50639cad
Sample Response
{
"created": "2018-07-23T15:01:04.527Z",
"lastAction": "2018-07-23T15:01:04.647Z",
"operation": "PatchScan",
"percentComplete": 100,
"resourceLocation": "https://device-name.example.com:3121/st/console/api/v1.0/patch/scans/3608e6f3-3f66-43b0-95db-ae1f50639cad",
"status": "Succeeded"
}Other Request Examples
Delete a long running operation
DELETE Request
https://<consoleFQDN:port>/st/console/api/v1.0/operations/c4d73af0-2d28-4124-a626-883a93f57f37
Output Models
OperationStatus
| Name | Type | Description |
|---|---|---|
|
created |
DateTime |
Gets the time that the operation was created. |
|
error |
Operation-specific error. |
|
|
lastAction |
DateTime |
Gets the date and time that the operation was last updated. |
|
operation |
Specifies the type of operation. |
|
|
percentComplete |
Integer |
Gets the operation completion percentage. |
|
resourceLocation |
Uri |
Gets the resource location of a completed operation. |
|
status |
Gets the operation status. |
Operation
| Name | Description |
|---|---|
|
patchDownload |
Patch download operation. |
|
patchDeployment |
Patch deployment operation. |
|
patchScan |
Patch scan operation. |
|
virtual |
Virtual operation. |
OperationState
| Name | Description |
|---|---|
|
running |
The operation is running. |
|
succeeded |
The operation has succeeded. This is a terminal state. |
|
failed |
The operation has failed. This is a terminal state. |
|
canceled |
The operation was canceled. This is a terminal state. |
OperationError
| Name | Type | Description |
|---|---|---|
|
code |
Integer |
Error code. |
|
message |
String |
Error message. For example: Cannot complete login due to an incorrect user name or password. |